iter-err: add ForEachErr and ForEachIdxErr#104
Open
ninedraft wants to merge 6 commits intosourcegraph:mainfrom
Open
iter-err: add ForEachErr and ForEachIdxErr#104ninedraft wants to merge 6 commits intosourcegraph:mainfrom
ninedraft wants to merge 6 commits intosourcegraph:mainfrom
Conversation
Author
|
Fixed linter issues |
Codecov Report
@@ Coverage Diff @@
## main #104 +/- ##
==========================================
+ Coverage 99.30% 99.36% +0.05%
==========================================
Files 12 12
Lines 433 474 +41
==========================================
+ Hits 430 471 +41
Misses 3 3
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
camdencheek
reviewed
Jun 1, 2023
Comment on lines
136
to
147
| task := func() { | ||
| i := int(idx.Add(1) - 1) | ||
| for ; i < numInput && !failed.Load(); i = int(idx.Add(1) - 1) { | ||
| if err := f(i, &input[i]); err != nil { | ||
| errsMu.Lock() | ||
| errs = multierror.Join(errs, err) | ||
| errsMu.Unlock() | ||
|
|
||
| failed.Store(iter.FailFast) | ||
| } | ||
| } | ||
| } |
Member
There was a problem hiding this comment.
It looks to me like FailFast does not guarantee returning only the error that caused the failure. One task can check if failed was set, error, and append its error while another task concurrently failed and appends an error.
I think this counts as surprising behavior given that the rest of the library guarantees that only the first error is retained when WithFirstError() is used.
I think we can fix this by checking the old value of failed:
Suggested change
| task := func() { | |
| i := int(idx.Add(1) - 1) | |
| for ; i < numInput && !failed.Load(); i = int(idx.Add(1) - 1) { | |
| if err := f(i, &input[i]); err != nil { | |
| errsMu.Lock() | |
| errs = multierror.Join(errs, err) | |
| errsMu.Unlock() | |
| failed.Store(iter.FailFast) | |
| } | |
| } | |
| } | |
| task := func() { | |
| i := int(idx.Add(1) - 1) | |
| for ; i < numInput && !failed.Load(); i = int(idx.Add(1) - 1) { | |
| if err := f(i, &input[i]); err != nil { | |
| if alreadyFailedFast := failed.Swap(iter.FailFast); !alreadyFailedFast { | |
| errsMu.Lock() | |
| errs = multierror.Join(errs, err) | |
| errsMu.Unlock() | |
| } | |
| } | |
| } | |
| } |
iter/iter_test.go
Outdated
Comment on lines
399
to
417
| t.Run("mutating inputs is fine", func(t *testing.T) { | ||
| t.Parallel() | ||
| ints := []int{1, 2, 3, 4, 5} | ||
| _ = forEach(ints, func(val *int) error { | ||
| *val += 1 | ||
| return nil | ||
| }) | ||
| require.Equal(t, []int{2, 3, 4, 5, 6}, ints) | ||
| }) | ||
|
|
||
| t.Run("mutating inputs is fine", func(t *testing.T) { | ||
| t.Parallel() | ||
| ints := []int{1, 2, 3, 4, 5} | ||
| _ = forEach(ints, func(val *int) error { | ||
| *val += 1 | ||
| return nil | ||
| }) | ||
| require.Equal(t, []int{2, 3, 4, 5, 6}, ints) | ||
| }) |
Member
There was a problem hiding this comment.
Looks like a duplicate
Suggested change
| t.Run("mutating inputs is fine", func(t *testing.T) { | |
| t.Parallel() | |
| ints := []int{1, 2, 3, 4, 5} | |
| _ = forEach(ints, func(val *int) error { | |
| *val += 1 | |
| return nil | |
| }) | |
| require.Equal(t, []int{2, 3, 4, 5, 6}, ints) | |
| }) | |
| t.Run("mutating inputs is fine", func(t *testing.T) { | |
| t.Parallel() | |
| ints := []int{1, 2, 3, 4, 5} | |
| _ = forEach(ints, func(val *int) error { | |
| *val += 1 | |
| return nil | |
| }) | |
| require.Equal(t, []int{2, 3, 4, 5, 6}, ints) | |
| }) | |
| t.Run("mutating inputs is fine", func(t *testing.T) { | |
| t.Parallel() | |
| ints := []int{1, 2, 3, 4, 5} | |
| _ = forEach(ints, func(val *int) error { | |
| *val += 1 | |
| return nil | |
| }) | |
| require.Equal(t, []int{2, 3, 4, 5, 6}, ints) | |
| }) |
Member
|
We should probably make Mapper respect the |
This was referenced Jun 1, 2023
Merged
camdencheek
added a commit
that referenced
this pull request
Jun 1, 2023
In #104, a "FailFast" option is likely going to be added to iterators that, on error, stops running additional tasks and returns the error that caused the first failure. "FailFast" seems is a pretty standard description for this behavior, and combining two common options into a single option with a more discoverable name seems like a nice thing to do before 1.0.
|
Is this still on the radar? |
Author
|
Yeah, I will refine the pr |
tanaka0722-dev
added a commit
to tanaka0722-dev/conc
that referenced
this pull request
Oct 16, 2025
In sourcegraph/conc#104, a "FailFast" option is likely going to be added to iterators that, on error, stops running additional tasks and returns the error that caused the first failure. "FailFast" seems is a pretty standard description for this behavior, and combining two common options into a single option with a more discoverable name seems like a nice thing to do before 1.0.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adding error returning iterators